1use crate::copp::clarabel_backend::ConstraintsClarabel;
32use crate::copp::copp3::Topp3Profile;
33use crate::copp::copp3::formulation::{Topp3Problem, get_weight_a_topp3};
34use crate::copp::copp3::opt3::ClarabelExpertInfor3rd;
35use crate::copp::copp3::opt3::clarabel_constraints::{
36 clarabel_standard_capacity_topp3, clarabel_standard_constraint_topp3,
37};
38use crate::copp::{ClarabelOptions, clarabel_to_copp3_solution};
39use crate::diag::{
40 CoppError, DebugVerboser, SilentVerboser, SummaryVerboser, TraceVerboser, Verboser, Verbosity,
41 check_boundary_state_copp3_valid, check_s_interval_valid, format_duration_human,
42};
43use clarabel::algebra::CscMatrix;
44use clarabel::solver::SupportedConeT::{NonnegativeConeT, SecondOrderConeT};
45use clarabel::solver::{DefaultSolution, DefaultSolver, IPSolver, SupportedConeT};
46
47pub fn topp3_socp(
66 problem: &Topp3Problem,
67 options: &ClarabelOptions,
68) -> Result<Topp3Profile, CoppError> {
69 let (result, solution) = topp3_socp_expert(problem, options)?;
70 result.ok_or_else(|| CoppError::ClarabelSolverStatus("topp3_socp".into(), solution.status))
71}
72
73pub fn topp3_socp_expert(
99 problem: &Topp3Problem,
100 options: &ClarabelOptions,
101) -> Result<(Option<Topp3Profile>, DefaultSolution<f64>), CoppError> {
102 let info = topp3_socp_expert_with_info(problem, options)?;
103 let _ = &info.linsolver;
104 Ok((info.result, info.solution))
105}
106
107pub fn topp3_socp_expert_with_info(
117 problem: &Topp3Problem,
118 options: &ClarabelOptions,
119) -> Result<ClarabelExpertInfor3rd, CoppError> {
120 match options.verbosity() {
121 Verbosity::Silent => topp3_socp_core(problem, (options, SilentVerboser)),
122 Verbosity::Summary => topp3_socp_core(problem, (options, SummaryVerboser::new())),
123 Verbosity::Debug => topp3_socp_core(problem, (options, DebugVerboser::new())),
124 Verbosity::Trace => topp3_socp_core(problem, (options, TraceVerboser::new())),
125 }
126}
127
128fn topp3_socp_core(
140 problem: &Topp3Problem,
141 options_verboser: (&ClarabelOptions, impl Verboser),
142) -> Result<ClarabelExpertInfor3rd, CoppError> {
143 let (options, mut verboser) = options_verboser;
144 let idx_s_start = problem.idx_s_start;
145 let a_boundary = problem.a_boundary;
146 let b_boundary = problem.b_boundary;
147 let num_stationary = problem.num_stationary;
148 if verboser.is_enabled(Verbosity::Summary) {
149 verboser.record_start_time();
150 }
151 if verboser.is_enabled(Verbosity::Trace) {
152 let settings = options.clarabel_settings();
153 crate::verbosity_log!(
154 crate::diag::Verbosity::Summary,
155 "topp3_socp: options snapshot -> allow(almost={}, max_iter={}, max_time={}, callback_term={}, insufficient_progress={}), tol_gap_rel={}, tol_feas={}, max_iter={}, verbose={}",
156 options.is_allow(clarabel::solver::SolverStatus::AlmostSolved),
157 options.is_allow(clarabel::solver::SolverStatus::MaxIterations),
158 options.is_allow(clarabel::solver::SolverStatus::MaxTime),
159 options.is_allow(clarabel::solver::SolverStatus::CallbackTerminated),
160 options.is_allow(clarabel::solver::SolverStatus::InsufficientProgress),
161 settings.tol_gap_rel,
162 settings.tol_feas,
163 settings.max_iter,
164 settings.verbose
165 );
166 }
167
168 check_boundary_state_copp3_valid(a_boundary, b_boundary)?;
170 let n = problem.a_linearization.len() - 1;
171 let idx_s_final = idx_s_start + n;
172 if verboser.is_enabled(Verbosity::Summary) {
173 crate::verbosity_log!(
174 crate::diag::Verbosity::Summary,
175 "\ntopp3_socp started: {} <= idx_s <= {}, s_len = {}, num_stationary={:?}.",
176 idx_s_start,
177 idx_s_final,
178 problem.a_linearization.len(),
179 num_stationary
180 );
181 }
182 check_s_interval_valid("topp3_socp", idx_s_start, idx_s_final)?;
183 let len_xi = length_xi_eta(n, num_stationary);
184 let id_xi_start = 2 * (n + 1);
185 let id_eta_start = id_xi_start + len_xi;
186 let (cap_val_lp, cap_b_lp, cap_cone_lp) =
196 clarabel_standard_capacity_topp3(problem.constraints, (idx_s_start, idx_s_final));
197 let (cap_val_qp, cap_b_qp, cap_cone_qp) = clarabel_capacity_topp3_qp(n);
198 if verboser.is_enabled(Verbosity::Debug) {
199 crate::verbosity_log!(
200 crate::diag::Verbosity::Summary,
201 "topp3_socp: capacity estimate lp(val={cap_val_lp}, b={cap_b_lp}, cone={cap_cone_lp}), qp(val={cap_val_qp}, b={cap_b_qp}, cone={cap_cone_qp}), n_var={}",
202 id_eta_start + len_xi
203 );
204 }
205 let mut cones = Vec::<SupportedConeT<f64>>::with_capacity(cap_cone_lp + cap_cone_qp);
206 let mut row = Vec::<usize>::with_capacity(cap_val_lp + cap_val_qp);
207 let mut col = Vec::<usize>::with_capacity(cap_val_lp + cap_val_qp);
208 let mut val = Vec::<f64>::with_capacity(cap_val_lp + cap_val_qp);
209 let mut b = Vec::<f64>::with_capacity(cap_b_lp + cap_b_qp);
210 if verboser.is_enabled(Verbosity::Trace) {
211 crate::verbosity_log!(
212 crate::diag::Verbosity::Summary,
213 "topp3_socp: allocated capacities row/col/val/b/cones <= {}/{}/{}/{}/{}",
214 cap_val_lp + cap_val_qp,
215 cap_val_lp + cap_val_qp,
216 cap_val_lp + cap_val_qp,
217 cap_b_lp + cap_b_qp,
218 cap_cone_lp + cap_cone_qp
219 );
220 }
221
222 let s = problem.constraints.s_vec(idx_s_start, idx_s_final + 1)?;
224 let row_before_std = row.len();
225 let col_before_std = col.len();
226 let val_before_std = val.len();
227 let b_before_std = b.len();
228 let cones_before_std = cones.len();
229 clarabel_standard_constraint_topp3(
230 problem,
231 &s,
232 (&mut row, &mut col, &mut val, &mut b, &mut cones),
233 num_stationary,
234 &verboser,
235 )?;
236 if verboser.is_enabled(Verbosity::Trace) {
237 crate::verbosity_log!(
238 crate::diag::Verbosity::Summary,
239 "topp3_socp: standard-constraints delta row/col/val/b/cones = +{}/+{}/+{}/+{}/+{}",
240 row.len() - row_before_std,
241 col.len() - col_before_std,
242 val.len() - val_before_std,
243 b.len() - b_before_std,
244 cones.len() - cones_before_std
245 );
246 }
247 let row_before_qp = row.len();
249 let col_before_qp = col.len();
250 let val_before_qp = val.len();
251 let b_before_qp = b.len();
252 let cones_before_qp = cones.len();
253 clarabel_constraint_topp3_qp(
254 (&mut row, &mut col, &mut val, &mut b, &mut cones),
255 (idx_s_start, idx_s_final),
256 num_stationary,
257 id_xi_start,
258 id_eta_start,
259 );
260 if verboser.is_enabled(Verbosity::Trace) {
261 crate::verbosity_log!(
262 crate::diag::Verbosity::Summary,
263 "topp3_socp: qp-aux delta row/col/val/b/cones = +{}/+{}/+{}/+{}/+{}",
264 row.len() - row_before_qp,
265 col.len() - col_before_qp,
266 val.len() - val_before_qp,
267 b.len() - b_before_qp,
268 cones.len() - cones_before_qp
269 );
270 }
271
272 let n_var = id_eta_start + len_xi;
274 let row_len = row.len();
275 let col_len = col.len();
276 let val_len = val.len();
277 let b_len = b.len();
278 let cones_len = cones.len();
279 let a_csc = CscMatrix::new_from_triplets(b.len(), n_var, row, col, val);
280 let p_object = CscMatrix::<f64>::zeros((n_var, n_var));
282 let q_object = clarabel_q_object_topp3_qp(&s, num_stationary, n_var, id_eta_start);
283 if verboser.is_enabled(Verbosity::Trace) {
284 let (q_min, q_max) = q_object
285 .iter()
286 .fold((f64::INFINITY, f64::NEG_INFINITY), |(mn, mx), &v| {
287 (mn.min(v), mx.max(v))
288 });
289 crate::verbosity_log!(
290 crate::diag::Verbosity::Summary,
291 "topp3_socp: matrix built with m={}, n={}, A.nnz={}, P.nnz={}, q_range=[{}, {}]",
292 b_len,
293 n_var,
294 a_csc.nnz(),
295 p_object.nnz(),
296 q_min,
297 q_max
298 );
299 }
300 if verboser.is_enabled(Verbosity::Summary) {
301 crate::verbosity_log!(
302 crate::diag::Verbosity::Summary,
303 "topp3_socp: ready to solve with row/col/val/b/cones = {row_len}/{col_len}/{val_len}/{b_len}/{cones_len} and n_var = {n_var}.",
304 );
305 }
306 let settings = options.clarabel_settings().clone();
308 let mut solver = DefaultSolver::<f64>::new(&p_object, &q_object, &a_csc, &b, &cones, settings)
309 .map_err(|e| CoppError::ClarabelSolverError("topp3_socp".into(), e))?;
310 solver.solve();
311 let linsolver = solver.info.linsolver.clone();
312 let solution = solver.solution;
313 if verboser.is_enabled(Verbosity::Summary) {
314 crate::verbosity_log!(
315 crate::diag::Verbosity::Summary,
316 "topp3_socp: solve done, status = {:?}, elapsed = {}.",
317 solution.status,
318 format_duration_human(verboser.elapsed())
319 );
320 }
321 if verboser.is_enabled(Verbosity::Trace) {
322 let show = solution.x.len().min(3);
323 crate::verbosity_log!(
324 crate::diag::Verbosity::Summary,
325 "topp3_socp: solution x_len={}, head={:?}",
326 solution.x.len(),
327 &solution.x[0..show]
328 );
329 }
330 let result = if options.is_allow(solution.status) {
331 Some(clarabel_to_copp3_solution(
332 &solution.x.as_slice()[0..2 * (n + 1)],
333 &s,
334 num_stationary,
335 ))
336 } else {
337 None
338 };
339 if verboser.is_enabled(Verbosity::Trace) {
340 crate::verbosity_log!(
341 crate::diag::Verbosity::Summary,
342 "topp3_socp: allow(status)={}, extracted_profile={}",
343 options.is_allow(solution.status),
344 if result.is_some() {
345 "Some(Topp3Profile)"
346 } else {
347 "None"
348 }
349 );
350 }
351 Ok(ClarabelExpertInfor3rd {
352 result,
353 solution,
354 linsolver,
355 })
356}
357
358#[inline(always)]
360fn length_xi_eta(n: usize, num_stationary: (usize, usize)) -> usize {
361 n + 1 - num_stationary.0.max(1) - num_stationary.1.max(1)
362}
363
364#[inline(always)]
366fn skip_a_for_xi(num_stationary_start: usize) -> usize {
367 num_stationary_start.max(1)
368}
369
370fn clarabel_constraint_topp3_qp(
376 constraints: ConstraintsClarabel,
377 idx_s_interval: (usize, usize),
378 num_stationary: (usize, usize),
379 id_xi_start: usize,
380 id_eta_start: usize,
381) {
382 let (idx_s_start, idx_s_final) = idx_s_interval;
383 let n = idx_s_final - idx_s_start;
384 let (row, col, val, b, cones) = constraints;
387 let len_xi = length_xi_eta(n, num_stationary);
392 let k_skip = skip_a_for_xi(num_stationary.0);
393 row.extend(b.len()..(b.len() + len_xi));
396 col.extend(id_xi_start..(id_xi_start + len_xi));
397 val.resize(val.len() + len_xi, -1.0);
398 b.resize(b.len() + len_xi, 0.0);
399 row.extend(b.len()..(b.len() + len_xi));
402 col.extend(id_eta_start..(id_eta_start + len_xi));
403 val.resize(val.len() + len_xi, -1.0);
404 b.resize(b.len() + len_xi, 0.0);
405 cones.push(NonnegativeConeT(2 * len_xi));
406 for k in 0..len_xi {
409 row.resize(row.len() + 2, b.len());
411 col.extend([id_xi_start + k, id_eta_start + k]);
412 val.extend([-1.0, -1.0]);
413 b.push(0.0);
414 row.resize(row.len() + 2, b.len());
416 col.extend([id_xi_start + k, id_eta_start + k]);
417 val.extend([-1.0, 1.0]);
418 b.push(0.0);
419 b.push(2.0);
421 }
422 for k in 0..len_xi {
426 row.push(b.len());
428 col.push(k_skip + k);
429 val.push(-1.0);
430 b.push(1.0);
431 row.push(b.len());
433 col.push(k_skip + k);
434 val.push(-1.0);
435 b.push(-1.0);
436 row.push(b.len());
438 col.push(id_xi_start + k);
439 val.push(-2.0);
440 b.push(0.0);
441 }
442 cones.resize(cones.len() + 2 * len_xi, SecondOrderConeT(3));
443}
444
445#[inline(always)]
447fn clarabel_q_object_topp3_qp(
448 s: &[f64],
449 num_stationary: (usize, usize),
450 n_var: usize,
451 id_eta_start: usize,
452) -> Vec<f64> {
453 let mut q_object = Vec::<f64>::with_capacity(n_var);
454 let weight = get_weight_a_topp3(s, num_stationary);
455 let len_eta = length_xi_eta(s.len() - 1, num_stationary);
456 let k_skip = skip_a_for_xi(num_stationary.0);
457 q_object.resize(id_eta_start, 0.0);
458 q_object.extend(weight[k_skip..(k_skip + len_eta)].iter());
459 q_object.resize(n_var, 0.0);
460 q_object
461}
462
463#[inline(always)]
467fn clarabel_capacity_topp3_qp(n: usize) -> (usize, usize, usize) {
468 let len_xi_upper_bound = n + 1;
476 (
477 9 * len_xi_upper_bound,
478 8 * len_xi_upper_bound,
479 2 * len_xi_upper_bound + 1,
480 )
481}
482
483#[cfg(test)]
484mod tests {
485 use super::*;
486 use crate::copp::copp2::stable::basic::{Topp2ProblemBuilder, s_to_t_topp2};
487 use crate::copp::copp2::stable::reach_set2::{ReachSet2Options, ReachSet2OptionsBuilder};
488 use crate::copp::copp2::stable::topp2_ra::topp2_ra;
489 use crate::copp::copp3::stable::basic::{Topp3ProblemBuilder, s_to_t_topp3};
490 use crate::copp::{ClarabelOptions, ClarabelOptionsBuilder};
491 use crate::path::{add_symmetric_axial_limits_for_test, lissajous_path_for_test};
492 use crate::robot::robot_core::Robot;
493 use crate::solver::topp3_lp::topp3_lp;
494 use core::f64;
495 use nalgebra::DMatrix;
496 use std::time::Instant;
497
498 #[test]
499 fn test_topp3_lp_qp() -> Result<(), CoppError> {
500 run_test_topp3_lp_qp_repeated(1, false)
501 }
502
503 #[test]
506 #[ignore = "slow"]
507 fn test_topp3_lp_qp_robust() -> Result<(), CoppError> {
508 run_test_topp3_lp_qp_repeated(100, true)
509 }
510
511 fn run_one_topp3_lp_qp_case(
512 options_ra: &ReachSet2Options,
513 options_lp: &ClarabelOptions,
514 options_qp: &ClarabelOptions,
515 ) -> Result<(f64, f64, f64, f64, f64, f64), CoppError> {
516 let n: usize = 1000;
517 let dim = 7;
518 let mut rng = rand::rng();
519 let (_s_uniform, path, _, _) =
520 lissajous_path_for_test(dim, n, &mut rng).expect("random range is valid");
521
522 let mut robot = Robot::with_capacity(dim, n);
523 let s = DMatrix::<f64>::from_fn(1, n, |_, j| {
524 (j as f64
525 + (if 0 < j && 2 * j < n { 0.5 } else { 0.0 }
526 + if n > j && 2 * j > n { 0.5 } else { 0.0 })
527 * j as f64
528 / n as f64)
529 * (1.0 / (n - 1) as f64)
530 });
531 robot
532 .with_s(&s.as_view())?
533 .with_q_from_path_3rd(&path, 0, n)?;
534 add_symmetric_axial_limits_for_test(&mut robot, 1.0, 1.0, Some(5.0))?;
535
536 let topp2_problem = Topp2ProblemBuilder::new(&robot, (0, n - 1), (0.0, 0.0)).build()?;
537 let start = Instant::now();
538 let a_ra = topp2_ra(&topp2_problem, options_ra)?;
539 let tc_ra = start.elapsed().as_secs_f64() * 1E3;
540 let (tf_ra, _) = s_to_t_topp2(s.as_slice(), &a_ra, 0.0)?;
541
542 robot.constraints.amax_substitute(&a_ra, 0)?;
543 let topp3_problem = Topp3ProblemBuilder::new(&mut robot, 0, &a_ra, (0.0, 0.0), (0.0, 0.0))
544 .with_num_stationary_max(2)
545 .build_with_linearization()?;
546
547 let start = Instant::now();
548 let profile_lp = topp3_lp(&topp3_problem, options_lp)?;
549 let tc_lp = start.elapsed().as_secs_f64() * 1E3;
550 let (tf_lp, _) = s_to_t_topp3(s.as_slice(), profile_lp.as_parts(), 0.0)?;
551
552 let start = Instant::now();
553 let profile_qp = topp3_socp(&topp3_problem, options_qp)?;
554 let tc_qp = start.elapsed().as_secs_f64() * 1E3;
555 let (tf_qp, _) = s_to_t_topp3(s.as_slice(), profile_qp.as_parts(), 0.0)?;
556
557 Ok((tc_ra, tc_lp, tc_qp, tf_ra, tf_lp, tf_qp))
558 }
559
560 fn run_test_topp3_lp_qp_repeated(n_exp: usize, flag_print_step: bool) -> Result<(), CoppError> {
561 let options_ra = ReachSet2OptionsBuilder::new()
562 .lp_feas_tol(1E-9)
563 .a_cmp_abs_tol(1E-9)
564 .a_cmp_rel_tol(1E-9)
565 .build()?;
566 let options_lp = ClarabelOptionsBuilder::new()
567 .allow_almost_solved(true)
568 .build()?;
569 let options_qp = ClarabelOptionsBuilder::new()
570 .allow_almost_solved(true)
571 .build()?;
572
573 let mut tc_sum_ra = 0.0;
574 let mut tc_sum_lp = 0.0;
575 let mut tc_sum_qp = 0.0;
576 let mut tf_sum_ra = 0.0;
577 let mut tf_sum_lp = 0.0;
578 let mut tf_sum_qp = 0.0;
579 let mut succeed = 0;
580
581 for i_exp in 0..n_exp {
582 if let Ok((tc_ra, tc_lp, tc_qp, tf_ra, tf_lp, tf_qp)) =
583 run_one_topp3_lp_qp_case(&options_ra, &options_lp, &options_qp)
584 {
585 if flag_print_step {
586 crate::verbosity_log!(
587 crate::diag::Verbosity::Summary,
588 "Exp #{}: tc_ra = {:.4} ms, tc_lp = {:.4} ms, tc_qp = {:.4} ms, tf_ra = {:.4}, tf_lp = {:.4}, tf_qp = {:.4}",
589 i_exp + 1,
590 tc_ra,
591 tc_lp,
592 tc_qp,
593 tf_ra,
594 tf_lp,
595 tf_qp,
596 );
597 }
598 tc_sum_ra += tc_ra;
599 tc_sum_lp += tc_lp;
600 tc_sum_qp += tc_qp;
601 tf_sum_ra += tf_ra;
602 tf_sum_lp += tf_lp;
603 tf_sum_qp += tf_qp;
604 succeed += 1;
605 }
606 }
607
608 crate::verbosity_log!(
609 crate::diag::Verbosity::Summary,
610 "Average (fail {}): tc_ra = {:.4} ms, tc_lp = {:.4} ms, tc_qp = {:.4} ms, tf_ra = {:.4}, tf_lp = {:.4}, tf_qp = {:.4}",
611 n_exp - succeed,
612 tc_sum_ra / succeed as f64,
613 tc_sum_lp / succeed as f64,
614 tc_sum_qp / succeed as f64,
615 tf_sum_ra / succeed as f64,
616 tf_sum_lp / succeed as f64,
617 tf_sum_qp / succeed as f64,
618 );
619
620 Ok(())
621 }
622}